-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added API components for Processes and Jobs
- Loading branch information
Showing
12 changed files
with
844 additions
and
167 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| id: amstelveen | ||
| title: OGC API Demo Service | ||
| description: OGC APIs are constructed as "building blocks" that can be used to assemble novel APIs for web access to geospatial content | ||
| description: OGC APIs are constructed as 'building blocks' that can be used to assemble novel APIs for web access to geospatial content | ||
| metadata: | ||
| contactName: Jane Doe | ||
| contactEmail: [email protected] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| { | ||
| "fJob": { | ||
| "name": "f", | ||
| "in": "query", | ||
| "description": "Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.", | ||
| "required": false, | ||
| "style": "form", | ||
| "explode": false, | ||
| "schema": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "html", | ||
| "json" | ||
| ] | ||
| } | ||
| }, | ||
| "fResults": { | ||
| "name": "f", | ||
| "in": "query", | ||
| "description": "Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.", | ||
| "required": false, | ||
| "style": "form", | ||
| "explode": false, | ||
| "schema": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "html", | ||
| "json" | ||
| ] | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| { | ||
| "Jobs": { | ||
| "type": "object", | ||
| "required": [ | ||
| "id", "links" | ||
| ], | ||
| "properties": { | ||
| "itemType": { | ||
| "type": "string" | ||
| }, | ||
| "id": { | ||
| "type": "string" | ||
| }, | ||
| "description": { | ||
| "type": "string" | ||
| }, | ||
| "title": { | ||
| "type": "string" | ||
| }, | ||
| "links": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/link" | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| { | ||
| "/jobs":{ | ||
| "get":{ | ||
| "description":"Retrieve a list of jobs", | ||
| "operationId":"getJobs", | ||
| "responses":{ | ||
| "200": { | ||
| "description": "The operation was executed successfully.", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Jobs" | ||
| } | ||
| }, | ||
| "text/html": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/htmlSchema" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "404":{ | ||
| "$ref":"https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/responses/NotFound.yaml" | ||
| } | ||
| }, | ||
| "summary":"Retrieve jobs list", | ||
| "tags":[ | ||
| "Jobs" | ||
| ] | ||
| } | ||
| }, | ||
| "/jobs/{jobId}":{ | ||
| "delete":{ | ||
| "description":"Cancel / delete job", | ||
| "operationId":"deleteJob", | ||
| "parameters":[ | ||
| { | ||
| "description":"job identifier", | ||
| "in":"path", | ||
| "name":"jobId", | ||
| "required":true, | ||
| "schema":{ | ||
| "type":"string" | ||
| } | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200": { | ||
| "description": "The operation was executed successfully.", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Process" | ||
| } | ||
| }, | ||
| "text/html": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/htmlSchema" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "404":{ | ||
| "$ref":"https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/responses/NotFound.yaml" | ||
| } | ||
| }, | ||
| "summary":"Cancel / delete job", | ||
| "tags":[ | ||
| "Jobs" | ||
| ] | ||
| }, | ||
| "get":{ | ||
| "description":"Retrieve job details", | ||
| "operationId":"getJob", | ||
| "parameters":[ | ||
| { | ||
| "description":"job identifier", | ||
| "in":"path", | ||
| "name":"jobId", | ||
| "required":true, | ||
| "schema":{ | ||
| "type":"string" | ||
| } | ||
| }, | ||
| { | ||
| "$ref":"#/components/parameters/fJob" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200": { | ||
| "description": "The operation was executed successfully.", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Process" | ||
| } | ||
| }, | ||
| "text/html": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/htmlSchema" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "404":{ | ||
| "$ref":"https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/responses/NotFound.yaml" | ||
| } | ||
| }, | ||
| "summary":"Retrieve job details", | ||
| "tags":[ | ||
| "Jobs" | ||
| ] | ||
| } | ||
| }, | ||
| "/jobs/{jobId}/results":{ | ||
| "get":{ | ||
| "description":"Retrieve job results", | ||
| "operationId":"getJobResults", | ||
| "parameters":[ | ||
| { | ||
| "description":"job identifier", | ||
| "in":"path", | ||
| "name":"jobId", | ||
| "required":true, | ||
| "schema":{ | ||
| "type":"string" | ||
| } | ||
| }, | ||
| { | ||
| "$ref":"#/components/parameters/fResults" | ||
| } | ||
| ], | ||
| "responses":{ | ||
| "200": { | ||
| "description": "The operation was executed successfully.", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Process" | ||
| } | ||
| }, | ||
| "text/html": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/htmlSchema" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "404":{ | ||
| "$ref":"https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/responses/NotFound.yaml" | ||
| } | ||
| }, | ||
| "summary":"Retrieve job results", | ||
| "tags":[ | ||
| "Jobs" | ||
| ] | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| { | ||
| "fProcesses": { | ||
| "name": "f", | ||
| "in": "query", | ||
| "description": "Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.", | ||
| "required": false, | ||
| "style": "form", | ||
| "explode": false, | ||
| "schema": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "html", | ||
| "json" | ||
| ] | ||
| } | ||
| }, | ||
| "fProcess": { | ||
| "name": "f", | ||
| "in": "query", | ||
| "description": "Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the accept header will be used to determine the format.", | ||
| "required": false, | ||
| "style": "form", | ||
| "explode": false, | ||
| "schema": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "html", | ||
| "json" | ||
| ] | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| { | ||
| "Processes": { | ||
| "type": "object", | ||
| "required": [ | ||
| "links", | ||
| "processes" | ||
| ], | ||
| "properties": { | ||
| "processes": { | ||
| "type": "array", | ||
| "items": { | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/components/schemas/Collection" | ||
| }, | ||
| { | ||
| "$ref": "#/components/schemas/Collection-link" | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "description": { | ||
| "type": "string" | ||
| }, | ||
| "title": { | ||
| "type": "string" | ||
| }, | ||
| "links": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/link" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "process-link": { | ||
| "properties": { | ||
| "links": { | ||
| "items": { | ||
| "$ref": "#/components/schemas/link" | ||
| }, | ||
| "type": "array" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "links" | ||
| ], | ||
| "type": "object" | ||
| }, | ||
| "Process": { | ||
| "type": "object", | ||
| "required": [ | ||
| "id", "links" | ||
| ], | ||
| "properties": { | ||
| "itemType": { | ||
| "type": "string" | ||
| }, | ||
| "id": { | ||
| "type": "string" | ||
| }, | ||
| "description": { | ||
| "type": "string" | ||
| }, | ||
| "title": { | ||
| "type": "string" | ||
| }, | ||
| "links": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/link" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.