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.

Sign up for GitHub

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

(DOCSP-33503) Unhide Find Your App ID CLI procedure #619

Merged
merged 3 commits into from
Nov 6, 2023
Merged

(DOCSP-33503) Unhide Find Your App ID CLI procedure #619

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c9c0586
(DOCSP-33503) Unhide Find Your App ID CLI procedure
nlarew Nov 1, 2023
eb78c90
fix errors
nlarew Nov 1, 2023
4f49427
re-add Atlas
nlarew Nov 6, 2023
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
37 changes: 24 additions & 13 deletions source/apps/metadata.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,35 +106,39 @@ or App Services CLI to find it programmatically.
Make sure to replace ``<access_token>`` and ``{groupId}`` with
your own values.

.. .. tab::
.. tab::
:tabid: cli

.. To find an App ID, run :ref:`{+cli-bin+} apps list
To find an App ID, run :ref:`{+cli-bin+} apps list
<appservices-apps-list>` and find the App you're interested in the
list returned by the command.

.. Each entry in the list contains two App ID values you may want:
Each entry in the list shows an App's project ID as well as two App
ID values you may want:

.. - The Client App ID, which is a unique string that includes the
- The Client App ID, which is a unique string that includes the
App name. Use this value to connect to your App through GraphQL,
the Data API, or a Realm SDK.

.. - The ``_id`` value, which is an internal ObjectId hex string. Use
- The ``_id`` value, which is an internal ObjectId hex string. Use
this value in place of ``{appId}`` in Admin API endpoints.

.. .. io-code-block::
.. io-code-block::

.. .. input::
.. input::
:language: bash

.. {+cli-bin+} apps list
{+cli-bin+} apps list

.. .. output::
.. output::
:language: text

.. Found 2 apps
myapp-abcde (63ea9328dddad2523e60fb59)
myapp-dev-uvxyz (63ea93318d947aff90351070)
Found 3 apps
Client App ID Project ID _id
------------------------------- ------------------------ ------------------------
myapp-abcde 5b2ef33692f119212341b213 64343a2b2107b2523e60fb59
myapp-dev-uvxyz 5b2ef33692f119212341b213 6526d3582b032aff90351070
my-other-app-abcde 5b2ef33692f119212341b213 674c19acef214b9ad99a0bbe

.. _find-atlas-project-id:

Expand Down Expand Up @@ -188,7 +192,7 @@ or Atlas CLI to find it programmatically.
:alt: Expanded ellipses icon showing the Actions menu and the copy
:width: 400px

.. tab:: Atlas CLI
.. tab:: CLI
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. I noticed the tab title on the page for the procedure we're un-hiding above is "App Services CLI" and the tab title of this procedure is just "CLI." It looks like we're using .. tabs-realm-admin-interfaces:: above, and for this procedure, we're just using .. tabs:: in ln 155. Should we use the same tab group as above for consistency?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This procedure can't use the realm-admin-interfaces tabset because it's using all the Atlas stuff. It'd be cool if we could link the App Services CLI and Atlas CLI tabs together but alas they are not currently connected.

:tabid: cli

You can list all Atlas projects that you have access to with the
Expand All @@ -197,6 +201,13 @@ or Atlas CLI to find it programmatically.
The command returns a list of projects in JSON format. Find
your project in the list and copy its ``id`` value.

.. tip::

The {+cli+} includes Project IDs when you list Apps. If you
want to find the Project ID of an existing App, you can run
``{+cli-bin+} apps list``. To learn more, see
:ref:`find-app-id`.

.. io-code-block::

.. input::
Expand Down
Loading