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

feat: remove references to content folder #365

Merged
merged 6 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Re `APIWG-#` (`Jira` ticket)
- [ ] I have performed a self-review of my own changes
- [ ] I have run `yarn lint` to make sure my changes pass all linters
- [ ] I have pulled the latest changes from the upstream developer branch
- [ ] I have run `yarn build:schema` and included changes in `openapi.json`

## Contribution guidelines

Expand Down
57 changes: 10 additions & 47 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,42 +53,10 @@ jobs:
run: |
yarn install

- name: Lint the content
- name: Lint API specification and markdown
run: |
yarn lint

# Verify compiled schema is up to date
# If this action fails, it means one have to run `yarn build:schema` and commit changes in the file
verify-compiled-schema-up-to-date:
name: Verify openapi.json file is up to date
# We run this on the latest ubuntu
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/staging' || github.event_name == 'pull_request'
timeout-minutes: 10

# We use node 14.X
strategy:
matrix:
node-version: [14.x]

# The following steps are performed for each job
steps:
- name: Check out the repo
uses: actions/checkout@v3

- name: Set up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}

- name: Compile the content
run: |
yarn install
yarn build:schema

- name: Verify openapi.json file is up to date (run 'yarn build:schema' and commit changes in openapi.json file if this command returns error)
run: git diff --quiet openapi.json

# The deploy task actually deploys any changes to the en branch
push-to-en:
# We run this on the latest ubuntu
Expand All @@ -115,18 +83,19 @@ jobs:
with:
node-version: ${{ matrix.node-version }}

- name: Compile the content
- name: Build content
run: |
yarn install
yarn build:spec
yarn build:content
yarn build:swagger

- name: Push compiled content
- name: Push API specification
uses: s0/git-publish-subdir-action@v2.4.0
env:
REPO: self
BRANCH: en
FOLDER: compiled/content
FOLDER: compiled/spec
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Push GH pages for redundancy
Expand Down Expand Up @@ -210,17 +179,17 @@ jobs:
with:
node-version: ${{ matrix.node-version }}

- name: Compile the content
- name: Build content
run: |
yarn install
yarn build:content
yarn build:spec

- name: Push compiled content
- name: Push API specification
uses: s0/git-publish-subdir-action@v2.4.0
env:
REPO: self
BRANCH: en-staging
FOLDER: compiled/content
FOLDER: compiled/spec
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: "Trigger Netlify deployment"
Expand Down Expand Up @@ -266,12 +235,6 @@ jobs:
with:
node-version: 16.x

- name: Compile the content
run: |
cd $GITHUB_WORKSPACE/box-openapi
yarn install
yarn build:content

- name: Check out the Codegen repo
uses: actions/checkout@v3
with:
Expand All @@ -286,5 +249,5 @@ jobs:
npm install
cd scripts
npm install
cp $GITHUB_WORKSPACE/box-openapi/compiled/content/openapi.json .
cp $GITHUB_WORKSPACE/box-openapi/openapi.json .
npm run generate ./openapi.json output typescript,swift,python,c#
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ src/dev/scripts/objects/*
src/dev/index.build.js
migrate.js
compiled
yarn-error.log

#Intelij Idea
*.iml
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

This repository contains the build system for the Box OpenAPI 3.0 Specification (OAS3) of the [Box Platform API](https://developers.box.com/).

> **Note**: Due to changes in API schema development process, this repository is currently frozen. This means we are not actively contributing to the repository, apart from necessary fixes and improvements that help us to put the new process in place even faster.
> **Note**: Due to changes in API schema development process, this repository is currently frozen. This means we are not actively contributing to the repository, apart from necessary fixes and improvements that help us to put the new process in place even faster.
You can still use the raw sources for specification available in the **Download** section.

## Downloads
Expand All @@ -23,7 +23,7 @@ following builds.
## Swagger 2.0

The older and incomplete Swagger 2.0 specification is still available on the
[Swagger 2.0](https://github.com/box/box-openapi/tree/swagger_2.0) branch.
[Swagger 2.0](https://github.com/box/box-openapi/tree/legacy-swagger-2.0/v2.0) branch.

## Contribution

Expand Down
37 changes: 0 additions & 37 deletions content/attributes/access_token--embedded.yml

This file was deleted.

38 changes: 0 additions & 38 deletions content/attributes/access_token--skill_invocation.yml

This file was deleted.

30 changes: 0 additions & 30 deletions content/attributes/action_type.yml

This file was deleted.

18 changes: 0 additions & 18 deletions content/attributes/boxapi_header.yml

This file was deleted.

27 changes: 0 additions & 27 deletions content/attributes/classification.yml

This file was deleted.

9 changes: 0 additions & 9 deletions content/attributes/collaboration_allowlist_entry_id.yml

This file was deleted.

This file was deleted.

17 changes: 0 additions & 17 deletions content/attributes/collaboration_can_view_path.yml

This file was deleted.

8 changes: 0 additions & 8 deletions content/attributes/collaboration_id.yml

This file was deleted.

12 changes: 0 additions & 12 deletions content/attributes/collaboration_role.yml

This file was deleted.

9 changes: 0 additions & 9 deletions content/attributes/collection_id.yml

This file was deleted.

9 changes: 0 additions & 9 deletions content/attributes/comment_id.yml

This file was deleted.

10 changes: 0 additions & 10 deletions content/attributes/content_md5.yml

This file was deleted.

Loading