mirror of
https://github.com/dathere/ckanaction.git
synced 2025-11-09 14:19:49 +00:00
chore(docs): update endpoints to use POST requests
This commit is contained in:
parent
0eaf2eb000
commit
ebbe179fbf
3 changed files with 40 additions and 36 deletions
|
|
@ -2,7 +2,7 @@
|
||||||
title: /package_search
|
title: /package_search
|
||||||
full: true
|
full: true
|
||||||
_openapi:
|
_openapi:
|
||||||
method: GET
|
method: POST
|
||||||
route: /package_search
|
route: /package_search
|
||||||
toc: []
|
toc: []
|
||||||
structuredData:
|
structuredData:
|
||||||
|
|
@ -15,4 +15,4 @@ _openapi:
|
||||||
|
|
||||||
Searches for packages satisfying a given search criteria.
|
Searches for packages satisfying a given search criteria.
|
||||||
|
|
||||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"/package_search","method":"get"}]} webhooks={[]} hasHead={false} />
|
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"/package_search","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
title: /package_show
|
title: /package_show
|
||||||
full: true
|
full: true
|
||||||
_openapi:
|
_openapi:
|
||||||
method: GET
|
method: POST
|
||||||
route: /package_show
|
route: /package_show
|
||||||
toc: []
|
toc: []
|
||||||
structuredData:
|
structuredData:
|
||||||
|
|
@ -15,4 +15,4 @@ _openapi:
|
||||||
|
|
||||||
Return the metadata of a dataset and its resources.
|
Return the metadata of a dataset and its resources.
|
||||||
|
|
||||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"/package_show","method":"get"}]} webhooks={[]} hasHead={false} />
|
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"/package_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||||
|
|
@ -60,8 +60,7 @@ paths:
|
||||||
summary: /package_list
|
summary: /package_list
|
||||||
description: This endpoint lists CKAN resources.
|
description: This endpoint lists CKAN resources.
|
||||||
requestBody:
|
requestBody:
|
||||||
description: 'Application object that needs to be created.'
|
required: false
|
||||||
required: true
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -102,10 +101,29 @@ paths:
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
'/package_show':
|
'/package_show':
|
||||||
get:
|
post:
|
||||||
operationId: /package_show
|
operationId: /package_show
|
||||||
summary: /package_show
|
summary: /package_show
|
||||||
description: Return the metadata of a dataset and its resources.
|
description: Return the metadata of a dataset and its resources.
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
type: string
|
||||||
|
description: the id or name of the dataset
|
||||||
|
default: ""
|
||||||
|
use_default_schema:
|
||||||
|
type: boolean
|
||||||
|
description: use default package schema instead of a custom schema defined with an IDatasetForm plugin
|
||||||
|
include_plugin_data:
|
||||||
|
type: boolean
|
||||||
|
description: Include the internal plugin data object (sysadmin only)
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: rust
|
- lang: rust
|
||||||
label: Rust SDK (ckanaction) example
|
label: Rust SDK (ckanaction) example
|
||||||
|
|
@ -132,19 +150,24 @@ paths:
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
parameters:
|
|
||||||
- in: query
|
|
||||||
name: id
|
|
||||||
description: The ID or name of the dataset
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
default: ""
|
|
||||||
'/package_search':
|
'/package_search':
|
||||||
get:
|
post:
|
||||||
operationId: /package_search
|
operationId: /package_search
|
||||||
summary: /package_search
|
summary: /package_search
|
||||||
description: Searches for packages satisfying a given search criteria.
|
description: Searches for packages satisfying a given search criteria.
|
||||||
|
requestBody:
|
||||||
|
required: false
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
q:
|
||||||
|
type: string
|
||||||
|
description: the solr query.
|
||||||
|
fq:
|
||||||
|
type: string
|
||||||
|
description: "any filter queries to apply. Note: `+site_id:{ckan_site_id}` is added to this string prior to the query being executed."
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: rust
|
- lang: rust
|
||||||
label: Rust SDK (ckanaction) example
|
label: Rust SDK (ckanaction) example
|
||||||
|
|
@ -171,22 +194,3 @@ paths:
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
parameters:
|
|
||||||
- in: query
|
|
||||||
name: q
|
|
||||||
description: the solr query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
default: "*:*"
|
|
||||||
- in: query
|
|
||||||
name: fq
|
|
||||||
description: any filter queries to apply
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
default: "*:*"
|
|
||||||
- in: query
|
|
||||||
name: include_private
|
|
||||||
description: if `True`, private datasets will be included in the results. Only private datasets from the user's organizations will be returned and sysadmins will be returned all private datasets.
|
|
||||||
schema:
|
|
||||||
type: boolean
|
|
||||||
default: false
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue