Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: change to schemas.jina.ai #6078

Merged
merged 1 commit into from
Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/concepts/client/third-party-clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ The response you receive includes `data` (an array of [Documents](https://docarr
:class: seealso
For a more detailed descripton of the REST API of a generic Flow, including the complete request body schema and request samples, please check:

1. [OpenAPI Schema](https://api.jina.ai/rest/latest.json)
2. [Redoc UI](https://api.jina.ai/rest/)
1. [OpenAPI Schema](https://schemas.jina.ai/rest/latest.json)
2. [Redoc UI](https://schemas.jina.ai/rest/)

For a specific deployed Flow, you can get the same overview by accessing the `/redoc` endpoint.
```
Expand Down Expand Up @@ -240,7 +240,7 @@ Here you can see all the endpoints that are exposed by the Flow, such as `/searc
To send a request, click on the endpoint you want to target, then `Try it out`.

Now you can enter your HTTP request, and send it by clicking `Execute`.
You can again use the [REST HTTP request schema](https://api.jina.ai/rest/), but do not need to specify `execEndpoint`.
You can again use the [REST HTTP request schema](https://schemas.jina.ai/rest/), but do not need to specify `execEndpoint`.

Below, in `Responses`, you can see the reply, together with a visual representation of the returned Documents.

Expand Down Expand Up @@ -322,4 +322,4 @@ The Flow defaults to `json` if you don't specify a sub-protocol while establishi

- {ref}`Access a Flow with the Client <client>`
- {ref}`Configure a Flow <flow-cookbook>`
- [Flow REST API reference](https://api.jina.ai/rest/)
- [Flow REST API reference](https://schemas.jina.ai/rest/)
4 changes: 2 additions & 2 deletions docs/concepts/orchestration/yaml-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We provide a [JSON Schema](https://json-schema.org/) for your IDE to enable code
### PyCharm users

1. Click menu `Preferences` -> `JSON Schema mappings`;
2. Add a new schema, in the `Schema File or URL` write `https://api.jina.ai/schemas/latest.json`; select `JSON Schema Version 7`;
2. Add a new schema, in the `Schema File or URL` write `https://schemas.jina.ai/schemas/latest.json`; select `JSON Schema Version 7`;
3. Add a file path pattern and link it to `*.jaml` or `*.jina.yml` or any suffix you commonly used for Jina Flow's YAML.

### VSCode users
Expand All @@ -20,7 +20,7 @@ We provide a [JSON Schema](https://json-schema.org/) for your IDE to enable code

```json
"yaml.schemas": {
"https://api.jina.ai/schemas/latest.json": ["/*.jina.yml", "/*.jaml"],
"https://schemas.jina.ai/schemas/latest.json": ["/*.jina.yml", "/*.jaml"],
}
```

Expand Down
2 changes: 1 addition & 1 deletion jina/schemas/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def get_full_schema() -> dict:
definitions.update(s)

return {
'$id': f'https://api.jina.ai/schemas/{__version__}.json',
'$id': f'https://schemas.jina.ai/schemas/{__version__}.json',
'$schema': 'http://json-schema.org/draft-07/schema#',
'description': 'The YAML schema of Jina objects (Flow, Executor).',
'type': 'object',
Expand Down
2 changes: 1 addition & 1 deletion scripts/get-openapi-schemas.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from jina.serve.runtimes.gateway.http_fastapi_app import get_fastapi_app
from jina.serve.runtimes.gateway.streamer import GatewayStreamer

JINA_LOGO_URL = 'https://api.jina.ai/logo/logo-product/jina-core/horizontal-layout/colored/Product%20logo_Core_vertical_colorful%402x-margin.png'
JINA_LOGO_URL = 'https://schemas.jina.ai/logo/logo-product/jina-core/horizontal-layout/colored/Product%20logo_Core_vertical_colorful%402x-margin.png'
GATEWAY_SCHEMA_FILENAME = 'gateway.json'


Expand Down