npm install
installs the dependenciesnpm start
builds API clientsnpm run docs
generates API documentation in HTMLnpm run watch
starts a local server which you can reach at http://localhost:8080npm run lint
lints your changes
This project relies on conventional commits used by release-please to generate proper changelogs and increment versions of the generated client libraries affected by the PR. Please use appropriate prefixes when giving titles to your PRs as they decide whether there will be a version bump and changelog entry.
These changelogs and version bumps are generated as a separate pull requests (one for each client library) and currently need to be merged manually.
You added an endpoint in Phrase Strings. In this project you do the following:
- Add newly added schema (if any) to
/schemas/
directory - Add new endpoints to
/paths/
directory and reference it inpaths.yaml
npm start
to re-build the clientsnpm run docs
to generate the documentation (and verify it in action usingnpm run watch
)- Open a PR with an informative title (e.g.
feat(api): Add an API endpoint for cat pics
)
The following repositories are generated upon pushing to this one:
https://github.com/phrase/phrase-go
https://github.com/phrase/phrase-java
https://github.com/phrase/phrase-js
https://github.com/phrase/phrase-php
https://github.com/phrase/phrase-python
https://github.com/phrase/phrase-ruby
https://github.com/phrase/phrase-cli
http://spec.openapis.org/oas/v3.0.3
https://swagger.io/specification/#specification
https://swagger.io/docs/specification/about/
POST
/PUT
requests should define parameters within requestBody
section, like the following:
requestBody:
required: true
content:
application/json:
schema:
type: object
title: key/create/parameters
properties:
branch:
description: specify the branch to use
type: string
example: my-feature-branch
name:
description: Key name
type: string
example: home.index.headline
parameters
section should contain only those parameters which are part of the URL (typically project_id
and/or account_id
)
Please contact support@phrase.com and we can take more direct action toward finding a solution.