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

Updates #121

Merged
merged 4 commits into from
Apr 4, 2024
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
27 changes: 18 additions & 9 deletions .github/workflows/lint-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,22 @@ jobs:
name: Run Linter
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: borales/actions-yarn@v3.0.0
- uses: actions/checkout@v4

- name: Enable Corepack
run: corepack enable

- name: Setup Node
uses: actions/setup-node@v3
with:
cmd: install # will run `yarn install` command
- uses: borales/actions-yarn@v3.0.0
with:
cmd: build # will run `yarn build` command
- uses: borales/actions-yarn@v3.0.0
with:
cmd: lint # will run `yarn test` command
node-version-file: '.nvmrc'
cache: "yarn"

- name: Install project dependencies
run: yarn

- name: Run Lint
run: yarn run build

- name: Run Lint
run: yarn run lint
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v20.11.0
4 changes: 4 additions & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
compressionLevel: mixed

enableGlobalCache: false

nodeLinker: node-modules
18 changes: 18 additions & 0 deletions Postman Docs/PodcastIndex.postman_collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -1233,6 +1233,9 @@
{
"name": "By Feed ID",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [],
"url": {
Expand Down Expand Up @@ -1265,6 +1268,9 @@
{
"name": "By Feed URL",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [],
"url": {
Expand Down Expand Up @@ -1297,6 +1303,9 @@
{
"name": "By Feed GUID",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [],
"url": {
Expand Down Expand Up @@ -1329,6 +1338,9 @@
{
"name": "By Episode GUID",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [],
"url": {
Expand Down Expand Up @@ -1366,6 +1378,9 @@
{
"name": "Batch By Episode GUID",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [],
"body": {
Expand Down Expand Up @@ -1472,6 +1487,9 @@
{
"name": "Pub Notify",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [],
"url": {
Expand Down
2 changes: 1 addition & 1 deletion api_src/components/schemas/item_search_byperson.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ properties:
id:
$ref: '../properties/id_episode.yaml'
title:
$ref: '../properties/title_feed.yaml'
$ref: '../properties/title_episode.yaml'
link:
$ref: '../properties/link_feed.yaml'
description:
Expand Down
12 changes: 6 additions & 6 deletions docs/pi_api.json
Original file line number Diff line number Diff line change
Expand Up @@ -2813,6 +2813,11 @@
"type": "integer",
"example": 16795088
},
"title_episode": {
"description": "Name of the episode\n",
"type": "string",
"example": "Gotham"
},
"description_episode": {
"description": "The item-level description of the episode.\n\n\nUses the longer of the possible fields in the feed: `<description>`, `<itunes:summary>` and `<content:encoded>`\n",
"type": "string",
Expand Down Expand Up @@ -2951,7 +2956,7 @@
"$ref": "#/components/schemas/id_episode"
},
"title": {
"$ref": "#/components/schemas/title_feed"
"$ref": "#/components/schemas/title_episode"
},
"link": {
"$ref": "#/components/schemas/link_feed"
Expand Down Expand Up @@ -4780,11 +4785,6 @@
}
}
},
"title_episode": {
"description": "Name of the episode\n",
"type": "string",
"example": "Gotham"
},
"items_soundbites": {
"description": "List of soundbites matching request\n",
"type": "array",
Expand Down
12 changes: 6 additions & 6 deletions docs/pi_api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2715,6 +2715,11 @@ components:
The internal PodcastIndex.org episode ID.
type: integer
example: 16795088
title_episode:
description: |
Name of the episode
type: string
example: Gotham
description_episode:
description: |
The item-level description of the episode.
Expand Down Expand Up @@ -2857,7 +2862,7 @@ components:
id:
$ref: '#/components/schemas/id_episode'
title:
$ref: '#/components/schemas/title_feed'
$ref: '#/components/schemas/title_episode'
link:
$ref: '#/components/schemas/link_feed'
description:
Expand Down Expand Up @@ -4300,11 +4305,6 @@ components:
$ref: '#/components/schemas/feeds_data'
items:
$ref: '#/components/schemas/items_data'
title_episode:
description: |
Name of the episode
type: string
example: Gotham
items_soundbites:
description: |
List of soundbites matching request
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "1.12.0",
"private": true,
"devDependencies": {
"@redocly/cli": "^1.3.0",
"@redocly/cli": "^1.10.6",
"copyfiles": "^2.4.1",
"http-server": "^14.1.1",
"livereload": "^0.9.3",
Expand All @@ -18,5 +18,6 @@
"local": "run-p -cln 'local:*'",
"local:reload": "livereload . -w 2000 -d -e html,css,js,png,gif,jpg,php,php5,py,rb,erb,coffee,yaml,json",
"local:server": "http-server docs -c 1 -p 8000"
}
},
"packageManager": "yarn@4.1.1"
}
Loading
Loading